@google-cloud/common

What is @google-cloud/common?

@google-cloud/common is a library that provides common functionality for Google Cloud Node.js client libraries. It includes utilities for logging, error handling, and making authenticated API requests.

What are @google-cloud/common's main functionalities?

Logging

The logging feature allows you to create and use a logger to log messages at different levels (info, error, etc.).

const { logger } = require('@google-cloud/common');
const log = logger();
log.info('This is an info message');
log.error('This is an error message');

Error Handling

The error handling feature provides a standardized way to create and handle API errors.

const { ApiError } = require('@google-cloud/common');
try {
  throw new ApiError({ message: 'An error occurred', code: 500 });
} catch (err) {
  console.error(err.message); // 'An error occurred'
  console.error(err.code); // 500
}

Authenticated API Requests

This feature allows you to make authenticated API requests to Google Cloud services.

const { Service } = require('@google-cloud/common');
const service = new Service({
  baseUrl: 'https://example.googleapis.com',
  scopes: ['https://www.googleapis.com/auth/cloud-platform']
});
service.request({
  method: 'GET',
  uri: '/v1/resource'
}, (err, response) => {
  if (err) {
    console.error(err);
  } else {
    console.log(response);
  }
});

Other packages similar to @google-cloud/common

axios

Axios is a promise-based HTTP client for the browser and Node.js. It provides similar functionality for making HTTP requests but does not include built-in support for Google Cloud authentication.

winston

Winston is a versatile logging library for Node.js. It offers more advanced logging features compared to @google-cloud/common but does not include other utilities like error handling or authenticated requests.

request

Request is a simplified HTTP client for Node.js. It provides similar functionality for making HTTP requests but is now deprecated in favor of more modern alternatives like axios.

README

Google Cloud Common: Node.js Client

Common components for Cloud APIs Node.js Client Libraries

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Google Cloud Common Node.js Client API Reference

• github.com/googleapis/nodejs-common

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

• Quickstart

  • Installing the client library

• Versioning

• Contributing

• License

Quickstart

Installing the client library

npm install @google-cloud/common

It's unlikely you will need to install this package directly, as it will be installed as a dependency when you install other @google-cloud packages.

The Google Cloud Common Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/common@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

Changelog

5.0.2 (2024-04-30)

Bug Fixes

• Replace ent with html-entities (7ec0a32)